12.3 删除终端信息

请求参数

Path: /api/v1/device/delete

Method: POST

接口描述:

  1. 删除一条终端信息。
  2. 可以基于 externalId 或 mac地址删除终端,不允许同时传入externalId和mac,否则报错。
  3. 基于 mac 删除终端时,如果匹配到多条数据,则不会删除,报错返回。
  4. 接口适用于 v2.2.7 及以上版本。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 必须  

Body

根据 externalId 删除

名称 类型 是否必须 默认值 备注 其他信息
externalId string 必须 外部ID  

请求示例

{
    "externalId": "0c4e9039-f81d-11ec-a760-fefcfe545bb7"
}

根据 mac 删除

名称 类型 是否必须 默认值 备注 其他信息
mac string 必须 MAC地址 匹配到多条终端时报错

请求示例

{
    "mac": "FE-FC-FE-21-F5-D1"
}

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 错误码,非0表示失败
data object 必须 响应数据
msg string 必须 描述信息
traceId string 必须 调用链ID,链路请求的标识  

返回示例

{
    "code": 0,
    "data": {},
    "msg": "请求成功",
    "traceId": "0022c672e4c8b0d6"
}

错误信息

错误提示 错误码
外部ID中不能含有非法的特殊字符:换行符,制表符,回车符 7201
外部ID长度超过最大上限:%d 7201
匹配到多条终端,请求失败 37400404
请输入匹配参数 10000001
请勿输入多个匹配参数: %s 10000001
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-05-18 14:38

results matching ""

    No results matching ""